Skip to content

Fix: mdsconnect of IDL API now always updates !MDS_SOCKET #3009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
mwinkel-dev wants to merge 6 commits into
base: alpha
Choose a base branch
from
Draft

Fix: mdsconnect of IDL API now always updates !MDS_SOCKET #3009

mwinkel-dev wants to merge 6 commits into from
+16 −9

Conversation

@mwinkel-dev
Copy link
Contributor

@mwinkel-dev mwinkel-dev commented Dec 16, 2025

Fixes issue #2996.

The IDL API has a system variable (i.e., global), !MDS_SOCKET, used to store the most recent connection ID. It is now updated whenever mdsconnect establishes a mdsip connection.

Example output follows . . .

IDL> CD, '/usr/local/mdsplus/lib'
IDL> mdsconnect, 'localhost'
% Compiled module: MDSCONNECT.
% Compiled module: MDS_KEYWORD_SET.
% Compiled module: MDSDISCONNECT.
IDL> print, !MDS_SOCKET
       0
IDL> mdsconnect, 'localhost'
IDL> print, !MDS_SOCKET
       1
IDL> mdsconnect, 'localhost'
IDL> print, !MDS_SOCKET
       2
IDL> conn_id = -1
IDL> mdsconnect, 'localhost', socket=conn_id
IDL> print, !MDS_SOCKET, conn_id
       3           3
IDL> mdsconnect, 'localhost', socket=conn_id
IDL> print, !MDS_SOCKET, conn_id
       4           4
IDL> mdsdisconnect, socket=conn_id
IDL> print, !MDS_SOCKET, conn_id
       4           4
IDL> mdsconnect, 'localhost', socket=conn_id
IDL> print, !MDS_SOCKET, conn_id
       5           5
IDL> mdsdisconnect
IDL> print, !MDS_SOCKET, conn_id
      -1           5
IDL> mdsconnect, 'localhost', socket=conn_id
IDL> print, !MDS_SOCKET, conn_id
       6           6
IDL> mdsconnect, 'localhost'
IDL> print, !MDS_SOCKET, conn_id
       7           6
IDL>

@mwinkel-dev mwinkel-dev self-assigned this Dec 16, 2025
@mwinkel-dev mwinkel-dev added the api/idl Relates to the IDL API label Dec 16, 2025
mwinkel-dev
mwinkel-dev commented Dec 16, 2025
View reviewed changes
idl/mdsconnect.pro
return
end

; This procedure is likely obsolete
Copy link
Contributor Author

@mwinkel-dev mwinkel-dev Dec 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This procedure is not used anywhere in the MDSplus source code. Plus it appears to be replaced by the mdsconnect procedure.

However, there is a chance that customers have old IDL programs that use this routine.

We should select one of these options:

  • delete the procedure, or
  • keep the procedure, or
  • add a print statement to it indicating that it is deprecated and the user should instead use mdsconnect

mwinkel-dev
mwinkel-dev commented Dec 16, 2025
View reviewed changes
idl/mdsconnect.pro
end


; This procedure is likely obsolete
Copy link
Contributor Author

@mwinkel-dev mwinkel-dev Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete, keep or deprecate?

@mwinkel-dev
Copy link
Contributor Author

mwinkel-dev commented Dec 17, 2025

This draft PR will probably be cancelled after some additional investigation. For more information, refer to the post on Issue #2996.

#2996 (comment)

@mwinkel-dev
Copy link
Contributor Author

mwinkel-dev commented Dec 19, 2025

Adding an optional database keyword to the MdsConnect procedure enables proper updating of !MDS_SOCKET and !MDSDB_SOCKET.

Even though this draft PR now passes the automated builds, it is debatable whether bug #2996 should be fixed or not.

@mwinkel-dev
Copy link
Contributor Author

mwinkel-dev commented Dec 20, 2025

This draft PR and the original code both pass the unmodified automated test, which proves that they are functionally equivalent. However, any change to existing code brings with it the risk of unintended consequences; an innocuous change can inadvertently introduce a subtle bug.

An alternate approach is to add comments to the original code explaining that the optional socket keyword to the MdsConnect procedure is reserved for use by the MdsDbConnect procedure. The presence of the socket keyword causes !MDSDB_SOCKET to be updated; its absence causes !MDS_SOCKET to be updated. Thus, user programs must not use the socket keyword when using MdsConnect to access a remote MDSplus archive server.

@mwinkel-dev mwinkel-dev mentioned this pull request Jan 9, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@WhoBrokeTheBuild WhoBrokeTheBuild Awaiting requested review from WhoBrokeTheBuild

@heidthecamp heidthecamp Awaiting requested review from heidthecamp

@joshStillerman joshStillerman Awaiting requested review from joshStillerman

@santorofer santorofer Awaiting requested review from santorofer

At least 1 approving review is required to merge this pull request.

Assignees

@mwinkel-dev mwinkel-dev

Labels

api/idl Relates to the IDL API

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@mwinkel-dev